Skip to content

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented May 8, 2025

update for redisvl 0.6.0

Copy link
Contributor

@andy-stark-redis andy-stark-redis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of suggestions, but minor stuff, so I'll approve.

* **Return type:**
None

#### `NOTE`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to render these notes in {{< note >}} ... {{< /note >}} shortcodes instead of h4 headings? No major problem if not, but currently the notes appear as headings at the same level as the method names (although I doubt anyone will confuse them for methods).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What should be wrapped in {{< note >}} ... {{< /note >}}? Just the literal NOTE or the whole thing?

Comment on lines +73 to +75
* [Add route references](semantic_router/#add-route-references)
* [Get route references](semantic_router/#get-route-references)
* [Delete route references](semantic_router/#delete-route-references)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are subheadings of Semantic Routing, so should be indented (looks like they currently aren't indented):

Suggested change
* [Add route references](semantic_router/#add-route-references)
* [Get route references](semantic_router/#get-route-references)
* [Delete route references](semantic_router/#delete-route-references)
* [Add route references](semantic_router/#add-route-references)
* [Get route references](semantic_router/#get-route-references)
* [Delete route references](semantic_router/#delete-route-references)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this is an existing problem, for instance for the Hash vs JSON Storage subheadings. I'll look into this

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is caused by some inconsistencies in the redisvl jupyter notebooks. I'll open some prs to get those fixed at the source.

@paoloredis paoloredis merged commit 44bc0aa into main May 9, 2025
1 check passed
@paoloredis paoloredis deleted the redisvl_docs_sync_0.6.0 branch May 9, 2025 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants